-
Notifications
You must be signed in to change notification settings - Fork 13
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
refactor(docs): autogenerate framework docs #1588
Conversation
✅ Vercel Preview Deployment is ready! |
✅ Vercel Preview Deployment is ready! |
Until the latest commit all this changes where basically visually identical to what SUI did. But the latest commit enables code blocks again. SUI says they had problems with code blocks, but I'm not sure why. I prefer code blocks in some places to highlight a word. So I removed their code and added some to fix the resulting issues with code tags and MDX. If someone sees any weird results in code blocks from that, just report it. We can add back their "fix" anytime |
✅ Vercel Preview Deployment is ready! |
Are all the docs supposed to be deleted now? |
Co-authored-by: DaughterOfMars <[email protected]>
I would say so, yes. I hate autogenerated docs that are checked in. But we can discuss it, if anyone has strong arguments to keep them |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good!
✅ Vercel Preview Deployment is ready! |
rustfmt is failing |
✅ Vercel Preview Deployment is ready! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
✅ Vercel Preview Deployment is ready! |
✅ Vercel Preview Deployment is ready! |
✅ Vercel Preview Deployment is ready! |
Description of change
I merged everything from the docusaurus plugin into the build script to have all needed changes in once place and let the build script output the docs directly to docusaurus. That way the docs will be autogenerated on demand.
Links to any relevant issues
Fixes #1035.
Type of change
How the change has been tested
Tested locally
Change checklist